/*******************************************************************************
 * Copyright (c) 2009 Dmitry Grushin <dgrushin@gmail.com>.
 * 
 * This file is part of GridMe.
 * 
 * GridMe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GridMe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GridMe.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     Dmitry Grushin <dgrushin@gmail.com> - initial API and implementation
 ******************************************************************************/
package statemachine.diagram.part;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.provider.IItemLabelProvider;
import org.eclipse.emf.edit.provider.ReflectiveItemProviderAdapterFactory;
import org.eclipse.emf.edit.provider.resource.ResourceItemProviderAdapterFactory;
import org.eclipse.emf.edit.ui.provider.ExtendedImageRegistry;
import org.eclipse.gmf.runtime.diagram.core.preferences.PreferencesHint;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.osgi.framework.BundleContext;

import statemachine.provider.StatemachineItemProviderAdapterFactory;

/**
* @generated
*/
public class StatemachineDiagramEditorPlugin extends AbstractUIPlugin
{

  /**
  * @generated
  */
  public static final String ID = "com.googlecode.gridme.simstate.diagram"; //$NON-NLS-1$

  /**
  * @generated
  */
  public static final PreferencesHint DIAGRAM_PREFERENCES_HINT = new PreferencesHint(
      ID);

  /**
  * @generated
  */
  private static StatemachineDiagramEditorPlugin instance;

  /**
  * @generated
  */
  private ComposedAdapterFactory adapterFactory;

  /**
  * @generated
  */
  private StatemachineDocumentProvider documentProvider;

  /**
  * @generated
  */
  public StatemachineDiagramEditorPlugin()
  {
  }

  /**
  * @generated
  */
  public void start(BundleContext context) throws Exception
  {
    super.start(context);
    instance = this;
    PreferencesHint.registerPreferenceStore(DIAGRAM_PREFERENCES_HINT,
        getPreferenceStore());
    adapterFactory = createAdapterFactory();
  }

  /**
  * @generated
  */
  public void stop(BundleContext context) throws Exception
  {
    adapterFactory.dispose();
    adapterFactory = null;
    instance = null;
    super.stop(context);
  }

  /**
  * @generated
  */
  public static StatemachineDiagramEditorPlugin getInstance()
  {
    return instance;
  }

  /**
  * @generated
  */
  protected ComposedAdapterFactory createAdapterFactory()
  {
    List factories = new ArrayList();
    fillItemProviderFactories(factories);
    return new ComposedAdapterFactory(factories);
  }

  /**
  * @generated
  */
  protected void fillItemProviderFactories(List factories)
  {
    factories.add(new StatemachineItemProviderAdapterFactory());
    factories.add(new ResourceItemProviderAdapterFactory());
    factories.add(new ReflectiveItemProviderAdapterFactory());
  }

  /**
  * @generated
  */
  public AdapterFactory getItemProvidersAdapterFactory()
  {
    return adapterFactory;
  }

  /**
  * @generated
  */
  public ImageDescriptor getItemImageDescriptor(Object item)
  {
    IItemLabelProvider labelProvider = (IItemLabelProvider) adapterFactory
        .adapt(item, IItemLabelProvider.class);
    if(labelProvider != null)
    {
      return ExtendedImageRegistry.getInstance().getImageDescriptor(
          labelProvider.getImage(item));
    }
    return null;
  }

  /**
   * Returns an image descriptor for the image file at the given
   * plug-in relative path.
   *
   * @generated
   * @param path the path
   * @return the image descriptor
   */
  public static ImageDescriptor getBundledImageDescriptor(String path)
  {
    return AbstractUIPlugin.imageDescriptorFromPlugin(ID, path);
  }

  /**
   * Respects images residing in any plug-in. If path is relative,
   * then this bundle is looked up for the image, otherwise, for absolute 
   * path, first segment is taken as id of plug-in with image
   *
   * @generated
   * @param path the path to image, either absolute (with plug-in id as first segment), or relative for bundled images
   * @return the image descriptor
   */
  public static ImageDescriptor findImageDescriptor(String path)
  {
    final IPath p = new Path(path);
    if(p.isAbsolute() && p.segmentCount() > 1)
    {
      return AbstractUIPlugin.imageDescriptorFromPlugin(p.segment(0), p
          .removeFirstSegments(1).makeAbsolute().toString());
    }
    else
    {
      return getBundledImageDescriptor(p.makeAbsolute().toString());
    }
  }

  /**
   * Returns an image for the image file at the given plug-in relative path.
   * Client do not need to dispose this image. Images will be disposed automatically.
   *
   * @generated
   * @param path the path
   * @return image instance
   */
  public Image getBundledImage(String path)
  {
    Image image = getImageRegistry().get(path);
    if(image == null)
    {
      getImageRegistry().put(path, getBundledImageDescriptor(path));
      image = getImageRegistry().get(path);
    }
    return image;
  }

  /**
   * Returns string from plug-in's resource bundle
   *
   * @generated
   */
  public static String getString(String key)
  {
    return Platform.getResourceString(getInstance().getBundle(), "%" + key); //$NON-NLS-1$
  }

  /**
  * @generated
  */
  public StatemachineDocumentProvider getDocumentProvider()
  {
    if(documentProvider == null)
    {
      documentProvider = new StatemachineDocumentProvider();
    }
    return documentProvider;
  }

  /**
  * @generated
  */
  public void logError(String error)
  {
    logError(error, null);
  }

  /**
  * @generated
  */
  public void logError(String error, Throwable throwable)
  {
    if(error == null && throwable != null)
    {
      error = throwable.getMessage();
    }
    getLog().log(
        new Status(IStatus.ERROR, StatemachineDiagramEditorPlugin.ID,
            IStatus.OK, error, throwable));
    debug(error, throwable);
  }

  /**
  * @generated
  */
  public void logInfo(String message)
  {
    logInfo(message, null);
  }

  /**
  * @generated
  */
  public void logInfo(String message, Throwable throwable)
  {
    if(message == null && throwable != null)
    {
      message = throwable.getMessage();
    }
    getLog().log(
        new Status(IStatus.INFO, StatemachineDiagramEditorPlugin.ID,
            IStatus.OK, message, throwable));
    debug(message, throwable);
  }

  /**
  * @generated
  */
  private void debug(String message, Throwable throwable)
  {
    if(!isDebugging())
    {
      return;
    }
    if(message != null)
    {
      System.err.println(message);
    }
    if(throwable != null)
    {
      throwable.printStackTrace();
    }
  }
}
